home *** CD-ROM | disk | FTP | other *** search
/ IRIX 6.2 Development Libraries / SGI IRIX 6.2 Development Libraries.iso / dist / complib.idb / usr / share / catman / p_man / cat3 / complib / ssyevx.z / ssyevx
Text File  |  1996-03-14  |  7KB  |  199 lines
  1.  
  2.  
  3.  
  4. SSSSSSSSYYYYEEEEVVVVXXXX((((3333FFFF))))                                                          SSSSSSSSYYYYEEEEVVVVXXXX((((3333FFFF))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      SSYEVX - compute selected eigenvalues and, optionally, eigenvectors of a
  10.      real symmetric matrix A
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      SUBROUTINE SSYEVX( JOBZ, RANGE, UPLO, N, A, LDA, VL, VU, IL, IU, ABSTOL,
  14.                         M, W, Z, LDZ, WORK, LWORK, IWORK, IFAIL, INFO )
  15.  
  16.          CHARACTER      JOBZ, RANGE, UPLO
  17.  
  18.          INTEGER        IL, INFO, IU, LDA, LDZ, LWORK, M, N
  19.  
  20.          REAL           ABSTOL, VL, VU
  21.  
  22.          INTEGER        IFAIL( * ), IWORK( * )
  23.  
  24.          REAL           A( LDA, * ), W( * ), WORK( * ), Z( LDZ, * )
  25.  
  26. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  27.      SSYEVX computes selected eigenvalues and, optionally, eigenvectors of a
  28.      real symmetric matrix A.  Eigenvalues and eigenvectors can be selected by
  29.      specifying either a range of values or a range of indices for the desired
  30.      eigenvalues.
  31.  
  32.  
  33. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  34.      JOBZ    (input) CHARACTER*1
  35.              = 'N':  Compute eigenvalues only;
  36.              = 'V':  Compute eigenvalues and eigenvectors.
  37.  
  38.      RANGE   (input) CHARACTER*1
  39.              = 'A': all eigenvalues will be found.
  40.              = 'V': all eigenvalues in the half-open interval (VL,VU] will be
  41.              found.  = 'I': the IL-th through IU-th eigenvalues will be found.
  42.  
  43.      UPLO    (input) CHARACTER*1
  44.              = 'U':  Upper triangle of A is stored;
  45.              = 'L':  Lower triangle of A is stored.
  46.  
  47.      N       (input) INTEGER
  48.              The order of the matrix A.  N >= 0.
  49.  
  50.      A       (input/output) REAL array, dimension (LDA, N)
  51.              On entry, the symmetric matrix A.  If UPLO = 'U', the leading N-
  52.              by-N upper triangular part of A contains the upper triangular
  53.              part of the matrix A.  If UPLO = 'L', the leading N-by-N lower
  54.              triangular part of A contains the lower triangular part of the
  55.              matrix A.  On exit, the lower triangle (if UPLO='L') or the upper
  56.              triangle (if UPLO='U') of A, including the diagonal, is
  57.              destroyed.
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. SSSSSSSSYYYYEEEEVVVVXXXX((((3333FFFF))))                                                          SSSSSSSSYYYYEEEEVVVVXXXX((((3333FFFF))))
  71.  
  72.  
  73.  
  74.      LDA     (input) INTEGER
  75.              The leading dimension of the array A.  LDA >= max(1,N).
  76.  
  77.      VL      (input) REAL
  78.              VU      (input) REAL If RANGE='V', the lower and upper bounds of
  79.              the interval to be searched for eigenvalues. VL < VU.  Not
  80.              referenced if RANGE = 'A' or 'I'.
  81.  
  82.      IL      (input) INTEGER
  83.              IU      (input) INTEGER If RANGE='I', the indices (in ascending
  84.              order) of the smallest and largest eigenvalues to be returned.  1
  85.              <= IL <= IU <= N, if N > 0; IL = 1 and IU = 0 if N = 0.  Not
  86.              referenced if RANGE = 'A' or 'V'.
  87.  
  88.      ABSTOL  (input) REAL
  89.              The absolute error tolerance for the eigenvalues.  An approximate
  90.              eigenvalue is accepted as converged when it is determined to lie
  91.              in an interval [a,b] of width less than or equal to
  92.  
  93.              ABSTOL + EPS *   max( |a|,|b| ) ,
  94.  
  95.              where EPS is the machine precision.  If ABSTOL is less than or
  96.              equal to zero, then  EPS*|T|  will be used in its place, where
  97.              |T| is the 1-norm of the tridiagonal matrix obtained by reducing
  98.              A to tridiagonal form.
  99.  
  100.              Eigenvalues will be computed most accurately when ABSTOL is set
  101.              to twice the underflow threshold 2*SLAMCH('S'), not zero.  If
  102.              this routine returns with INFO>0, indicating that some
  103.              eigenvectors did not converge, try setting ABSTOL to
  104.              2*SLAMCH('S').
  105.  
  106.              See "Computing Small Singular Values of Bidiagonal Matrices with
  107.              Guaranteed High Relative Accuracy," by Demmel and Kahan, LAPACK
  108.              Working Note #3.
  109.  
  110.      M       (output) INTEGER
  111.              The total number of eigenvalues found.  0 <= M <= N.  If RANGE =
  112.              'A', M = N, and if RANGE = 'I', M = IU-IL+1.
  113.  
  114.      W       (output) REAL array, dimension (N)
  115.              On normal exit, the first M elements contain the selected
  116.              eigenvalues in ascending order.
  117.  
  118.      Z       (output) REAL array, dimension (LDZ, max(1,M))
  119.              If JOBZ = 'V', then if INFO = 0, the first M columns of Z contain
  120.              the orthonormal eigenvectors of the matrix A corresponding to the
  121.              selected eigenvalues, with the i-th column of Z holding the
  122.              eigenvector associated with W(i).  If an eigenvector fails to
  123.              converge, then that column of Z contains the latest approximation
  124.              to the eigenvector, and the index of the eigenvector is returned
  125.              in IFAIL.  If JOBZ = 'N', then Z is not referenced.  Note: the
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. SSSSSSSSYYYYEEEEVVVVXXXX((((3333FFFF))))                                                          SSSSSSSSYYYYEEEEVVVVXXXX((((3333FFFF))))
  137.  
  138.  
  139.  
  140.              user must ensure that at least max(1,M) columns are supplied in
  141.              the array Z; if RANGE = 'V', the exact value of M is not known in
  142.              advance and an upper bound must be used.
  143.  
  144.      LDZ     (input) INTEGER
  145.              The leading dimension of the array Z.  LDZ >= 1, and if JOBZ =
  146.              'V', LDZ >= max(1,N).
  147.  
  148.      WORK    (workspace/output) REAL array, dimension (LWORK)
  149.              On exit, if INFO = 0, WORK(1) returns the optimal LWORK.
  150.  
  151.      LWORK   (input) INTEGER
  152.              The length of the array WORK.  LWORK >= max(1,8*N).  For optimal
  153.              efficiency, LWORK >= (NB+3)*N, where NB is the blocksize for
  154.              SSYTRD returned by ILAENV.
  155.  
  156.      IWORK   (workspace) INTEGER array, dimension (5*N)
  157.  
  158.      IFAIL   (output) INTEGER array, dimension (N)
  159.              If JOBZ = 'V', then if INFO = 0, the first M elements of IFAIL
  160.              are zero.  If INFO > 0, then IFAIL contains the indices of the
  161.              eigenvectors that failed to converge.  If JOBZ = 'N', then IFAIL
  162.              is not referenced.
  163.  
  164.      INFO    (output) INTEGER
  165.              = 0:  successful exit
  166.              < 0:  if INFO = -i, the i-th argument had an illegal value
  167.              > 0:  if INFO = i, then i eigenvectors failed to converge.  Their
  168.              indices are stored in array IFAIL.
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.